/* ---------------------------------------------------------------------------- */
/*                  Atmel Microcontroller Software Support                      */
/*                       SAM Software Package License                           */
/* ---------------------------------------------------------------------------- */
/* Copyright (c) 2015, Atmel Corporation                                        */
/*                                                                              */
/* All rights reserved.                                                         */
/*                                                                              */
/* Redistribution and use in source and binary forms, with or without           */
/* modification, are permitted provided that the following condition is met:    */
/*                                                                              */
/* - Redistributions of source code must retain the above copyright notice,     */
/* this list of conditions and the disclaimer below.                            */
/*                                                                              */
/* Atmel's name may not be used to endorse or promote products derived from     */
/* this software without specific prior written permission.                     */
/*                                                                              */
/* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,      */
/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,  */
/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    */
/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING         */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                           */
/* ---------------------------------------------------------------------------- */

/**
 * \file
 *
 * The flash driver provides the unified interface for flash program operations.
 *
 */

#ifndef _FLASHD_
#define _FLASHD_

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

#define GPNVBit_SecurityBit     0
#define GPNVBit_BootMode        1
#define GPNVBit_TCMBit1         6
#define GPNVBit_TCMBit2         7

/*----------------------------------------------------------------------------
 *        Exported functions
 *----------------------------------------------------------------------------*/

extern void FLASHD_Initialize(uint32_t dwMCk, uint32_t dwUseIAP);

extern uint32_t FLASHD_Erase(uint32_t dwAddress);

extern uint32_t FLASHD_EraseSector(uint32_t dwAddress);

extern uint32_t FLASHD_ErasePages(uint32_t dwAddress, uint32_t dwPageNum);

extern uint32_t FLASHD_Write(uint32_t dwAddress, const void *pvBuffer,
							  uint32_t dwSize);

extern uint32_t FLASHD_Lock(uint32_t dwStart, uint32_t dwEnd,
							 uint32_t *pdwActualStart, uint32_t *pdwActualEnd);

extern uint32_t FLASHD_Unlock(uint32_t dwStart, uint32_t dwEnd,
							   uint32_t *pdwActualStart, uint32_t *pdwActualEnd);

extern uint32_t FLASHD_IsLocked(uint32_t dwStart, uint32_t dwEnd);

extern uint32_t FLASHD_SetGPNVM(uint8_t gpnvm);

extern uint32_t FLASHD_ClearGPNVM(uint8_t gpnvm);

extern uint32_t FLASHD_IsGPNVMSet(uint8_t gpnvm);

#define FLASHD_IsSecurityBitSet() FLASHD_IsGPNVMSet(0)

#define FLASHD_SetSecurityBit()   FLASHD_SetGPNVM(0)

extern uint32_t FLASHD_ReadUniqueID(uint32_t *pdwUniqueID);

#ifdef __cplusplus
}
#endif

#endif /* #ifndef _FLASHD_ */

